From 16cf23959f17c240b5b1faf7802cffd1f51363ab Mon Sep 17 00:00:00 2001 From: =?utf8?q?Javier=20Jard=C3=B3n?= Date: Fri, 22 Oct 2010 21:59:08 +0200 Subject: [PATCH] gtktreeviewcolumn: Move documentation to inline comments --- docs/reference/gtk/tmpl/.gitignore | 1 + .../reference/gtk/tmpl/gtktreeviewcolumn.sgml | 624 ------------------ gtk/gtktreeviewcolumn.c | 18 + gtk/gtktreeviewcolumn.h | 31 +- 4 files changed, 47 insertions(+), 627 deletions(-) delete mode 100644 docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore index 9d74162e5b..66a28214a3 100644 --- a/docs/reference/gtk/tmpl/.gitignore +++ b/docs/reference/gtk/tmpl/.gitignore @@ -51,5 +51,6 @@ gtktoolitem.sgml gtktooltip.sgml gtktreednd.sgml gtktreestore.sgml +gtktreeviewcolumn.sgml gtktypeutils.sgml gtkwindow.sgml diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml deleted file mode 100644 index 5340150e27..0000000000 --- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml +++ /dev/null @@ -1,624 +0,0 @@ - -GtkTreeViewColumn - - -A visible column in a GtkTreeView widget - - - -The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget. -It allows to set properties of the column header, and functions as a holding pen for -the cell renderers which determine how the data in the column is displayed. - - - -Please refer to the tree widget conceptual overview -for an overview of all the objects and data types related to the tree widget and how -they work together. - - - - -#GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle - - - - - - - - - - - -The sizing method the column uses to determine its width. Please note -that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and -can make columns appear choppy. - - -@GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model -@GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes. -@GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide. - - - -A function to set the properties of a cell instead of just using the -straight mapping between the cell and the model. This is useful for -customizing the cell renderer. For example, a function might get an -integer from the @tree_model, and render it to the "text" attribute of -"cell" by converting it to its written equivilent. This is set by -calling gtk_tree_view_column_set_cell_data_func() - - -@tree_column: A #GtkTreeColumn -@cell: The #GtkCellRenderer that is being rendered by @tree_column -@tree_model: The #GtkTreeModel being rendered -@iter: A #GtkTreeIter of the current row rendered -@data: user data - - - - - - - - - - - - - -@treeviewcolumn: the object which received the signal. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@void: -@Returns: - - - - - - - -@title: -@cell: -@Varargs: -@Returns: - - - - - - - -@tree_column: -@cell: -@expand: - - - - - - - -@tree_column: -@cell: -@expand: - - - - - - - -@tree_column: - - - - - - - -@tree_column: -@cell_renderer: -@attribute: -@column: - - - - - - - -@tree_column: -@cell_renderer: -@Varargs: - - - - - - - -@tree_column: -@cell_renderer: -@func: -@func_data: -@destroy: - - - - - - - -@tree_column: -@cell_renderer: - - - - - - - -@tree_column: -@spacing: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@visible: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@resizable: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@type: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@fixed_width: - - - - - - - -@tree_column: -@min_width: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@max_width: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: - - - - - - - -@tree_column: -@title: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@expand: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@clickable: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@widget: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@xalign: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@reorderable: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@sort_column_id: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@setting: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@order: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@tree_model: -@iter: -@is_expander: -@is_expanded: - - - - - - - -@tree_column: -@cell_area: -@x_offset: -@y_offset: -@width: -@height: - - - - - - - -@tree_column: -@cell_renderer: -@start_pos: -@width: -@Returns: - - - - - - - -@tree_column: -@Returns: - - - - - - - -@tree_column: -@cell: - - - - - - - -@tree_column: - - - - - - - -@tree_column: -@Returns: - - diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c index ad576f68f3..a62165b281 100644 --- a/gtk/gtktreeviewcolumn.c +++ b/gtk/gtktreeviewcolumn.c @@ -36,6 +36,24 @@ #include "gtkintl.h" +/** + * SECTION:gtktreeviewcolumn + * @Short_description: A visible column in a GtkTreeView widget + * @Title: GtkTreeViewColumn + * @See_also: #GtkTreeView, #GtkTreeSelection, #GtkTreeDnd, #GtkTreeMode, #GtkTreeSortable, + * #GtkTreeModelSort, #GtkListStore, #GtkTreeStore, #GtkCellRenderer, #GtkCellEditable, + * #GtkCellRendererPixbuf, #GtkCellRendererText, #GtkCellRendererToggle + * + * The GtkTreeViewColumn object represents a visible column in a #GtkTreeView widget. + * It allows to set properties of the column header, and functions as a holding pen for + * the cell renderers which determine how the data in the column is displayed. + * + * Please refer to the tree widget conceptual overview + * for an overview of all the objects and data types related to the tree widget and how + * they work together. + */ + + enum { PROP_0, diff --git a/gtk/gtktreeviewcolumn.h b/gtk/gtktreeviewcolumn.h index a19adf2360..6c0b3a1e88 100644 --- a/gtk/gtktreeviewcolumn.h +++ b/gtk/gtktreeviewcolumn.h @@ -39,6 +39,19 @@ G_BEGIN_DECLS #define GTK_IS_TREE_VIEW_COLUMN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GTK_TYPE_TREE_VIEW_COLUMN)) #define GTK_TREE_VIEW_COLUMN_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GTK_TYPE_TREE_VIEW_COLUMN, GtkTreeViewColumnClass)) +typedef struct _GtkTreeViewColumn GtkTreeViewColumn; +typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass; + +/** + * GtkTreeViewColumnSizing: + * @GTK_TREE_VIEW_COLUMN_GROW_ONLY: Columns only get bigger in reaction to changes in the model + * @GTK_TREE_VIEW_COLUMN_AUTOSIZE: Columns resize to be the optimal size everytime the model changes. + * @GTK_TREE_VIEW_COLUMN_FIXED: Columns are a fixed numbers of pixels wide. + * + * The sizing method the column uses to determine its width. Please note + * that @GTK_TREE_VIEW_COLUMN_AUTOSIZE are inefficient for large views, and + * can make columns appear choppy. + */ typedef enum { GTK_TREE_VIEW_COLUMN_GROW_ONLY, @@ -46,9 +59,21 @@ typedef enum GTK_TREE_VIEW_COLUMN_FIXED } GtkTreeViewColumnSizing; -typedef struct _GtkTreeViewColumn GtkTreeViewColumn; -typedef struct _GtkTreeViewColumnClass GtkTreeViewColumnClass; - +/** + * GtkTreeCellDataFunc: + * @tree_column: A #GtkTreeColumn + * @cell: The #GtkCellRenderer that is being rendered by @tree_column + * @tree_model: The #GtkTreeModel being rendered + * @iter: A #GtkTreeIter of the current row rendered + * @data: user data + * + * A function to set the properties of a cell instead of just using the + * straight mapping between the cell and the model. This is useful for + * customizing the cell renderer. For example, a function might get an + * integer from the @tree_model, and render it to the "text" attribute of + * "cell" by converting it to its written equivilent. This is set by + * calling gtk_tree_view_column_set_cell_data_func() + */ typedef void (* GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column, GtkCellRenderer *cell, GtkTreeModel *tree_model, -- 2.30.2